/Projects/{projectId}/points:batchDelete (Post)

Post	/Projects/{projectId}/points:batchDelete

In This Topic

Description

Deletes an array of points in the project

Parameters

Name	Description	Data Type
projectId	the id of the project	string

Request (application/json)

The request body is of type object.

Overview

PointIDs : Array[string]

Dynamic : boolean

200 Response

The response body is of type PointsPostResponse.

The collection of responses for the delete operation

Overview

PointsPostResponse

The results of the point create/update/delete operations.

NumSuccesses : number

The number of points that were successfully written.

NumFailures : number

The number of points that failed to be written.

WarningsMask : integer

a bitmask of warning conditions (e.g., WarningLicensePointCount)

PointResults : Array[ItemResult]

The results for each point in the request array.

Success : boolean

high level result (success true, failure false)

StatusDetails : integer

a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...)

WarningsMask : integer

a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG)

Message : string

(localized?) message about the result, probably empty for successes

Fault Responses

Fault	Description
404	This fault returns a response body of type ProblemDetails. Error if objects not found
400	This fault returns a response body of type ProblemDetails. General error